docs: add how-to guide for configuring a third-party agent - #45559
Merged
Conversation
…ample) Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
pelikhan
July 14, 2026 22:08
View session
Collaborator
|
@copilot use opencode as example. See smoke-opencode |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
Done. Replaced Gentek with OpenCode throughout the guide — using the actual engine definition from |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a how-to guide for importing third-party agent definitions into gh-aw.
Changes:
- Documents engine definitions, credentials, networking, and version pinning.
- Adds the guide to the documentation sidebar.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/guides/third-party-agent.md |
Adds the third-party agent guide and examples. |
docs/astro.config.mjs |
Adds sidebar navigation. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 9
- Review effort level: Medium
| order: 330 | ||
| --- | ||
|
|
||
| Third-party coding agent CLIs that are not built into gh-aw can integrate through a declarative engine definition file that the agent publisher distributes. This guide uses [OpenCode](https://opencode.ai) as a concrete open-source example. |
| ```aw wrap | ||
| on: issues | ||
|
|
||
| engine: opencode |
| engine: opencode | ||
|
|
||
| imports: | ||
| - sst/opencode/.github/workflows/opencode-engine.md@v1.2.14 |
Comment on lines
+100
to
+107
| network: | ||
| allowed: | ||
| - defaults | ||
| - api.anthropic.com | ||
|
|
||
| --- | ||
|
|
||
| Triage this issue and apply an appropriate label. |
| 1. Go to **Settings → Secrets and variables → Actions**. | ||
| 2. Create a new secret named `ANTHROPIC_API_KEY` with the value from your Anthropic account. | ||
|
|
||
| For other providers, set the corresponding key (for example `OPENAI_API_KEY` for OpenAI models) and reference it in your workflow's `engine.env` block. |
Comment on lines
+128
to
+130
| engine: | ||
| id: opencode | ||
| version: "1.3.0" |
| version: "1.3.0" | ||
|
|
||
| imports: | ||
| - sst/opencode/.github/workflows/opencode-engine.md@v1.2.14 |
|
|
||
| ## Example: OpenCode | ||
|
|
||
| OpenCode is an open-source, provider-agnostic AI coding agent (BYOK — Bring Your Own Key) that supports 75+ models from Anthropic, OpenAI, Google, Groq, and others via a unified CLI interface. |
|
|
||
| ## Add the API key secret | ||
|
|
||
| OpenCode reads provider credentials from environment variables. For the default Anthropic provider, add `ANTHROPIC_API_KEY` to your repository or organization: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
gh-aw has no documentation explaining how a third-party CLI coding agent (one not built into the binary) can be integrated via the
engine.behaviorsimport mechanism.Changes
docs/src/content/docs/guides/third-party-agent.md— new how-to guide using Gentek as a concrete open-source example:engine.behaviorsimport pattern: third-party agents publish an engine definition.mdfile; importing it registers the engine at compile time with no binary changesengine.version, and recompile reminderdocs/astro.config.mjs— adds "Third-Party Agent" to the Guides sidebarExample: workflow using an imported third-party engine